GET restapi/personal/instantmessages/recipients/search/v1?searchText={searchText}&instantMessageThreadId={instantMessageThreadId}&recipientRoles[0]={recipientRoles[0]}&recipientRoles[1]={recipientRoles[1]}

Gets persons that the user is allowed to communicate with given the customer's esafety rules configured in itslearning.

Request Information

URI Parameters

Name	Description	Type	Additional information
searchText	The person name to search for.	string	Required
instantMessageThreadId	People already included in this thread will be excluded from search result.	integer	None.
recipientRoles	List of recipient roles to filter. If the value is not set all allowed recipients are returned.	Collection of Itslearning.RestApi.Entities.InstantMessageRecipientRole	None.

Body Parameters

None.

Response Information

Resource Description

List of Person Simple

Collection of Itslearning.RestApi.Entities.InstantMessageRecipient

Name	Description	Type	Additional information
TypeName	TypeName can be: Person, Course, Project	string	None.
Id	Id for recipient	integer	None.
TypeNameId	Unique identifier for a Person, Course or Project. Formatted like "TypeName-Id"	string	None.
UserName	UserName for a Person, for other types is empty	string	None.
ExtraUserInformation	Contains extra user information which can be different depending on customer settings. It can be either username, synchronization key, any of 5 custom strings or none.	string	None.
Label	Label for recipient. Stores one of the following: Person Name, Course Title, Project Title	string	None.
EncodedLabel	Js-encoded Label for recipient.	string	None.
Organization	Organization for recipient.	string	None.
ShortLabel	Label for recipient. If Type = 0 this is set to persons initials	string	None.
SearchLabel	Additional label for search recipient. If Type = 0 this is set to person name in the general format "FirstName LastName".	string	None.
SortField	Label to sort on	integer	None.
ParticipantsCount	Used for Course or Projects. The number of participants in the conversation	integer	None.
ProfileImageUrl	URL to avatar image for this recipient	string	None.
ColorSchema	Color schema for this recipient	string	None.
Code	Extra code to be displayed after the recipients name	string	None.
CanReceive	Check if recipient can receive new messages	boolean	None.
RoleInHierarchyTitle	Name of the role in the home hierarchy.	string	None.

Response Formats

application/json, text/json

Sample:

[
  {
    "TypeName": "sample string 1",
    "Id": 2,
    "TypeNameId": "sample string 3",
    "UserName": "sample string 4",
    "ExtraUserInformation": "sample string 5",
    "Label": "sample string 6",
    "EncodedLabel": "sample string 7",
    "Organization": "sample string 8",
    "ShortLabel": "sample string 9",
    "SearchLabel": "sample string 10",
    "SortField": 11,
    "ParticipantsCount": 12,
    "ProfileImageUrl": "sample string 13",
    "ColorSchema": "sample string 14",
    "Code": "sample string 15",
    "CanReceive": true,
    "RoleInHierarchyTitle": "sample string 16"
  },
  {
    "TypeName": "sample string 1",
    "Id": 2,
    "TypeNameId": "sample string 3",
    "UserName": "sample string 4",
    "ExtraUserInformation": "sample string 5",
    "Label": "sample string 6",
    "EncodedLabel": "sample string 7",
    "Organization": "sample string 8",
    "ShortLabel": "sample string 9",
    "SearchLabel": "sample string 10",
    "SortField": 11,
    "ParticipantsCount": 12,
    "ProfileImageUrl": "sample string 13",
    "ColorSchema": "sample string 14",
    "Code": "sample string 15",
    "CanReceive": true,
    "RoleInHierarchyTitle": "sample string 16"
  }
]

application/xml, text/xml

Sample:

<ArrayOfInstantMessageRecipient xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Itslearning.RestApi.Entities">
  <InstantMessageRecipient>
    <CanReceive>true</CanReceive>
    <Code>sample string 15</Code>
    <ColorSchema>sample string 14</ColorSchema>
    <EncodedLabel>sample string 7</EncodedLabel>
    <ExtraUserInformation>sample string 5</ExtraUserInformation>
    <Id>2</Id>
    <Label>sample string 6</Label>
    <Organization>sample string 8</Organization>
    <ParticipantsCount>12</ParticipantsCount>
    <ProfileImageUrl>sample string 13</ProfileImageUrl>
    <RoleInHierarchyTitle>sample string 16</RoleInHierarchyTitle>
    <SearchLabel>sample string 10</SearchLabel>
    <ShortLabel>sample string 9</ShortLabel>
    <SortField>11</SortField>
    <TypeName>sample string 1</TypeName>
    <TypeNameId>sample string 3</TypeNameId>
    <UserName>sample string 4</UserName>
  </InstantMessageRecipient>
  <InstantMessageRecipient>
    <CanReceive>true</CanReceive>
    <Code>sample string 15</Code>
    <ColorSchema>sample string 14</ColorSchema>
    <EncodedLabel>sample string 7</EncodedLabel>
    <ExtraUserInformation>sample string 5</ExtraUserInformation>
    <Id>2</Id>
    <Label>sample string 6</Label>
    <Organization>sample string 8</Organization>
    <ParticipantsCount>12</ParticipantsCount>
    <ProfileImageUrl>sample string 13</ProfileImageUrl>
    <RoleInHierarchyTitle>sample string 16</RoleInHierarchyTitle>
    <SearchLabel>sample string 10</SearchLabel>
    <ShortLabel>sample string 9</ShortLabel>
    <SortField>11</SortField>
    <TypeName>sample string 1</TypeName>
    <TypeNameId>sample string 3</TypeNameId>
    <UserName>sample string 4</UserName>
  </InstantMessageRecipient>
</ArrayOfInstantMessageRecipient>